home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / gdb-4.5 / dist / gdb / minsyms.c < prev    next >
Encoding:
C/C++ Source or Header  |  1992-03-29  |  16.1 KB  |  488 lines
  1. /* GDB routines for manipulating the minimal symbol tables.
  2.    Copyright 1992 Free Software Foundation, Inc.
  3.    Contributed by Cygnus Support, using pieces from other GDB modules.
  4.  
  5. This file is part of GDB.
  6.  
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20.  
  21.  
  22. /* This file contains support routines for creating, manipulating, and
  23.    destroying minimal symbol tables.
  24.  
  25.    Minimal symbol tables are used to hold some very basic information about
  26.    all defined global symbols (text, data, bss, abs, etc).  The only two
  27.    required pieces of information are the symbol's name and the address
  28.    associated with that symbol.
  29.  
  30.    In many cases, even if a file was compiled with no special options for
  31.    debugging at all, as long as was not stripped it will contain sufficient
  32.    information to build useful minimal symbol tables using this structure.
  33.    
  34.    Even when a file contains enough debugging information to build a full
  35.    symbol table, these minimal symbols are still useful for quickly mapping
  36.    between names and addresses, and vice versa.  They are also sometimes used
  37.    to figure out what full symbol table entries need to be read in. */
  38.  
  39.  
  40. #include "defs.h"
  41. #include "symtab.h"
  42. #include "bfd.h"
  43. #include "symfile.h"
  44. #include "objfiles.h"
  45.  
  46. /* Accumulate the minimal symbols for each objfile in bunches of BUNCH_SIZE.
  47.    At the end, copy them all into one newly allocated location on an objfile's
  48.    symbol obstack.  */
  49.  
  50. #define BUNCH_SIZE 127
  51.  
  52. struct msym_bunch
  53. {
  54.   struct msym_bunch *next;
  55.   struct minimal_symbol contents[BUNCH_SIZE];
  56. };
  57.  
  58. /* Bunch currently being filled up.
  59.    The next field points to chain of filled bunches.  */
  60.  
  61. static struct msym_bunch *msym_bunch;
  62.  
  63. /* Number of slots filled in current bunch.  */
  64.  
  65. static int msym_bunch_index;
  66.  
  67. /* Total number of minimal symbols recorded so far for the objfile.  */
  68.  
  69. static int msym_count;
  70.  
  71. /* Prototypes for local functions. */
  72.  
  73. static int
  74. compare_minimal_symbols PARAMS ((const void *, const void *));
  75.  
  76. static int
  77. compact_minimal_symbols PARAMS ((struct minimal_symbol *, int));
  78.  
  79. /* Look through all the current minimal symbol tables and find the first
  80.    minimal symbol that matches NAME.  If OBJF is non-NULL, it specifies a
  81.    particular objfile and the search is limited to that objfile.  Returns
  82.    a pointer to the minimal symbol that matches, or NULL if no match is found.
  83.  
  84.    Note:  One instance where there may be duplicate minimal symbols with
  85.    the same name is when the symbol tables for a shared library and the
  86.    symbol tables for an executable contain global symbols with the same
  87.    names (the dynamic linker deals with the duplication). */
  88.  
  89. struct minimal_symbol *
  90. lookup_minimal_symbol (name, objf)
  91.      register const char *name;
  92.      struct objfile *objf;
  93. {
  94.   struct objfile *objfile;
  95.   struct minimal_symbol *msymbol;
  96.   struct minimal_symbol *found_symbol = NULL;
  97. #ifdef IBM6000_TARGET
  98.   struct minimal_symbol *trampoline_symbol = NULL;
  99. #endif
  100.  
  101.   for (objfile = object_files;
  102.        objfile != NULL && found_symbol == NULL;
  103.        objfile = objfile -> next)
  104.     {
  105.       if (objf == NULL || objf == objfile)
  106.     {
  107.       for (msymbol = objfile -> msymbols;
  108.            msymbol != NULL && msymbol -> name != NULL &&
  109.            found_symbol == NULL;
  110.            msymbol++)
  111.         {
  112.           if (strcmp (msymbol -> name, name) == 0)
  113.         {
  114. #ifdef IBM6000_TARGET
  115. /* I *think* all platforms using shared libraries (and trampoline code)
  116.  * will suffer this problem. Consider a case where there are 5 shared
  117.  * libraries, each referencing `foo' with a trampoline entry. When someone
  118.  * wants to put a breakpoint on `foo' and the only info we have is minimal
  119.  * symbol vector, we want to use the real `foo', rather than one of those
  120.  * trampoline entries. MGO */    
  121.       /* If a trampoline symbol is found, we prefer to keep looking
  122.          for the *real* symbol. If the actual symbol not found,
  123.          then we'll use the trampoline entry. Sorry for the machine
  124.          dependent code here, but I hope this will benefit other
  125.          platforms as well. For trampoline entries, we used mst_unknown
  126.          earlier. Perhaps we should define a `mst_trampoline' type?? */
  127.  
  128.           if (msymbol->type != mst_unknown)
  129.             found_symbol = msymbol;
  130.               else if (msymbol->type == mst_unknown && !trampoline_symbol)
  131.             trampoline_symbol = msymbol;
  132.              
  133. #else
  134.           found_symbol = msymbol;
  135. #endif
  136.         }
  137.         }
  138.     }
  139.     }
  140. #ifdef IBM6000_TARGET
  141.   return found_symbol ? found_symbol : trampoline_symbol;
  142. #endif
  143.  
  144.   return (found_symbol);
  145. }
  146.  
  147.  
  148. /* Search through the minimal symbol table for each objfile and find the
  149.    symbol whose address is the largest address that is still less than or
  150.    equal to PC.  Returns a pointer to the minimal symbol if such a symbol
  151.    is found, or NULL if PC is not in a suitable range.  Note that we need
  152.    to look through ALL the minimal symbol tables before deciding on the
  153.    symbol that comes closest to the specified PC. */
  154.  
  155. struct minimal_symbol *
  156. lookup_minimal_symbol_by_pc (pc)
  157.      register CORE_ADDR pc;
  158. {
  159.   register int lo;
  160.   register int hi;
  161.   register int new;
  162.   register struct objfile *objfile;
  163.   register struct minimal_symbol *msymbol;
  164.   register struct minimal_symbol *best_symbol = NULL;
  165.  
  166.   for (objfile = object_files;
  167.        objfile != NULL;
  168.        objfile = objfile -> next)
  169.     {
  170.       /* If this objfile has a minimal symbol table, go search it using
  171.      a binary search.  Note that a minimal symbol table always consists
  172.      of at least two symbols, a "real" symbol and the terminating
  173.      "null symbol".  If there are no real symbols, then there is no
  174.      minimal symbol table at all. */
  175.  
  176.       if ((msymbol = objfile -> msymbols) != NULL)
  177.     {
  178.       lo = 0;
  179.       hi = objfile -> minimal_symbol_count - 2;
  180.       
  181.       /* This code assumes that the minimal symbols are sorted by
  182.          ascending address values.  If the pc value is greater than or
  183.          equal to the first symbol's address, then some symbol in this
  184.          minimal symbol table is a suitable candidate for being the
  185.          "best" symbol.  This includes the last real symbol, for cases
  186.          where the pc value is larger than any address in this vector.
  187.  
  188.          By iterating until the address associated with the current
  189.          hi index (the endpoint of the test interval) is less than
  190.          or equal to the desired pc value, we accomplish two things:
  191.          (1) the case where the pc value is larger than any minimal
  192.          symbol address is trivially solved, (2) the address associated
  193.          with the hi index is always the one we want when the interation
  194.          terminates.  In essence, we are iterating the test interval
  195.          down until the pc value is pushed out of it from the high end.
  196.  
  197.          Warning: this code is trickier than it would appear at first. */
  198.  
  199.       /* Should also requires that pc is <= end of objfile.  FIXME! */
  200.       if (pc >= msymbol[lo].address)
  201.         {
  202.           while (msymbol[hi].address > pc)
  203.         {
  204.           /* pc is still strictly less than highest address */
  205.           /* Note "new" will always be >= lo */
  206.           new = (lo + hi) / 2;
  207.           if ((msymbol[new].address >= pc) || (lo == new))
  208.             {
  209.               hi = new;
  210.             }
  211.           else
  212.             {
  213.               lo = new;
  214.             }
  215.         }
  216.           /* The minimal symbol indexed by hi now is the best one in this
  217.          objfile's minimal symbol table.  See if it is the best one
  218.          overall. */
  219.  
  220.           if ((best_symbol == NULL) ||
  221.           (best_symbol -> address < msymbol[hi].address))
  222.         {
  223.           best_symbol = &msymbol[hi];
  224.         }
  225.         }
  226.     }      
  227.     }
  228.   return (best_symbol);
  229. }
  230.  
  231. /* Prepare to start collecting minimal symbols.  Note that presetting
  232.    msym_bunch_index to BUNCH_SIZE causes the first call to save a minimal
  233.    symbol to allocate the memory for the first bunch. */
  234.  
  235. void
  236. init_minimal_symbol_collection ()
  237. {
  238.   msym_count = 0;
  239.   msym_bunch = NULL;
  240.   msym_bunch_index = BUNCH_SIZE;
  241. }
  242.  
  243. void
  244. prim_record_minimal_symbol (name, address, ms_type)
  245.      const char *name;
  246.      CORE_ADDR address;
  247.      enum minimal_symbol_type ms_type;
  248. {
  249.   register struct msym_bunch *new;
  250.  
  251.   if (msym_bunch_index == BUNCH_SIZE)
  252.     {
  253.       new = (struct msym_bunch *) xmalloc (sizeof (struct msym_bunch));
  254.       msym_bunch_index = 0;
  255.       new -> next = msym_bunch;
  256.       msym_bunch = new;
  257.     }
  258.   msym_bunch -> contents[msym_bunch_index].name = (char *) name;
  259.   msym_bunch -> contents[msym_bunch_index].address = address;
  260.   msym_bunch -> contents[msym_bunch_index].info = NULL;
  261.   msym_bunch -> contents[msym_bunch_index].type = ms_type;
  262.   msym_bunch_index++;
  263.   msym_count++;
  264. }
  265.  
  266. /* Compare two minimal symbols by address and return a signed result based
  267.    on unsigned comparisons, so that we sort into unsigned numeric order.  */
  268.  
  269. static int
  270. compare_minimal_symbols (fn1p, fn2p)
  271.      const PTR fn1p;
  272.      const PTR fn2p;
  273. {
  274.   register const struct minimal_symbol *fn1;
  275.   register const struct minimal_symbol *fn2;
  276.  
  277.   fn1 = (const struct minimal_symbol *) fn1p;
  278.   fn2 = (const struct minimal_symbol *) fn2p;
  279.  
  280.   if (fn1 -> address < fn2 -> address)
  281.     {
  282.       return (-1);
  283.     }
  284.   else if (fn1 -> address > fn2 -> address)
  285.     {
  286.       return (1);
  287.     }
  288.   else
  289.     {
  290.       return (0);
  291.     }
  292. }
  293.  
  294. /* Discard the currently collected minimal symbols, if any.  If we wish
  295.    to save them for later use, we must have already copied them somewhere
  296.    else before calling this function.
  297.  
  298.    FIXME:  We could allocate the minimal symbol bunches on their own
  299.    obstack and then simply blow the obstack away when we are done with
  300.    it.  Is it worth the extra trouble though? */
  301.  
  302. /* ARGSUSED */
  303. void
  304. discard_minimal_symbols (foo)
  305.      int foo;
  306. {
  307.   register struct msym_bunch *next;
  308.  
  309.   while (msym_bunch != NULL)
  310.     {
  311.       next = msym_bunch -> next;
  312.       free ((PTR)msym_bunch);
  313.       msym_bunch = next;
  314.     }
  315. }
  316.  
  317. /* Compact duplicate entries out of a minimal symbol table by walking
  318.    through the table and compacting out entries with duplicate addresses
  319.    and matching names.  Return the number of entries remaining.
  320.  
  321.    On entry, the table resides between msymbol[0] and msymbol[mcount].
  322.    On exit, it resides between msymbol[0] and msymbol[result_count].
  323.  
  324.    When files contain multiple sources of symbol information, it is
  325.    possible for the minimal symbol table to contain many duplicate entries.
  326.    As an example, SVR4 systems use ELF formatted object files, which
  327.    usually contain at least two different types of symbol tables (a
  328.    standard ELF one and a smaller dynamic linking table), as well as
  329.    DWARF debugging information for files compiled with -g.
  330.  
  331.    Without compacting, the minimal symbol table for gdb itself contains
  332.    over a 1000 duplicates, about a third of the total table size.  Aside
  333.    from the potential trap of not noticing that two successive entries
  334.    identify the same location, this duplication impacts the time required
  335.    to linearly scan the table, which is done in a number of places.  So we
  336.    just do one linear scan here and toss out the duplicates.
  337.  
  338.    Note that we are not concerned here about recovering the space that
  339.    is potentially freed up, because the strings themselves are allocated
  340.    on the symbol_obstack, and will get automatically freed when the symbol
  341.    table is freed.  The caller can free up the unused minimal symbols at
  342.    the end of the compacted region if their allocation strategy allows it.
  343.  
  344.    Also note we only go up to the next to last entry within the loop
  345.    and then copy the last entry explicitly after the loop terminates.
  346.  
  347.    Since the different sources of information for each symbol may
  348.    have different levels of "completeness", we may have duplicates
  349.    that have one entry with type "mst_unknown" and the other with a
  350.    known type.  So if the one we are leaving alone has type mst_unknown,
  351.    overwrite its type with the type from the one we are compacting out.  */
  352.  
  353. static int
  354. compact_minimal_symbols (msymbol, mcount)
  355.      struct minimal_symbol *msymbol;
  356.      int mcount;
  357. {
  358.   struct minimal_symbol *copyfrom;
  359.   struct minimal_symbol *copyto;
  360.  
  361.   if (mcount > 0)
  362.     {
  363.       copyfrom = copyto = msymbol;
  364.       while (copyfrom < msymbol + mcount - 1)
  365.     {
  366.       if (copyfrom -> address == (copyfrom + 1) -> address
  367.           && (strcmp (copyfrom -> name, (copyfrom + 1) -> name) == 0))
  368.         {
  369.           if ((copyfrom + 1) -> type == mst_unknown)
  370.         {
  371.           (copyfrom + 1) -> type = copyfrom -> type;
  372.         }
  373.           copyfrom++;
  374.         }
  375.       else
  376.         {
  377.           *copyto++ = *copyfrom++;
  378.         }
  379.     }
  380.       *copyto++ = *copyfrom++;
  381.       mcount = copyto - msymbol;
  382.     }
  383.   return (mcount);
  384. }
  385.  
  386. /* Add the minimal symbols in the existing bunches to the objfile's
  387.    official minimal symbol table.  99% of the time, this adds the
  388.    bunches to NO existing symbols.  Once in a while for shared
  389.    libraries, we add symbols (e.g. common symbols) to an existing
  390.    objfile.  */
  391.  
  392. void
  393. install_minimal_symbols (objfile)
  394.      struct objfile *objfile;
  395. {
  396.   register int bindex;
  397.   register int mcount;
  398.   register struct msym_bunch *bunch;
  399.   register struct minimal_symbol *msymbols;
  400.   int alloc_count;
  401.  
  402.   if (msym_count > 0)
  403.     {
  404.       /* Allocate enough space in the obstack, into which we will gather the
  405.      bunches of new and existing minimal symbols, sort them, and then
  406.      compact out the duplicate entries.  Once we have a final table,
  407.      we will give back the excess space.  */
  408.  
  409.       alloc_count = msym_count + objfile->minimal_symbol_count + 1;
  410.       obstack_blank (&objfile->symbol_obstack,
  411.              alloc_count * sizeof (struct minimal_symbol));
  412.       msymbols = (struct minimal_symbol *)
  413.          obstack_base (&objfile->symbol_obstack);
  414.  
  415.       /* Copy in the existing minimal symbols, if there are any.  */
  416.  
  417.       if (objfile->minimal_symbol_count)
  418.         memcpy ((char *)msymbols, (char *)objfile->msymbols, 
  419.         objfile->minimal_symbol_count * sizeof (struct minimal_symbol));
  420.  
  421.       /* Walk through the list of minimal symbol bunches, adding each symbol
  422.      to the new contiguous array of symbols.  Note that we start with the
  423.      current, possibly partially filled bunch (thus we use the current
  424.      msym_bunch_index for the first bunch we copy over), and thereafter
  425.      each bunch is full. */
  426.       
  427.       mcount = objfile->minimal_symbol_count;
  428.       
  429.       for (bunch = msym_bunch; bunch != NULL; bunch = bunch -> next)
  430.     {
  431.       for (bindex = 0; bindex < msym_bunch_index; bindex++, mcount++)
  432.         {
  433.           msymbols[mcount] = bunch -> contents[bindex];
  434. #ifdef NAMES_HAVE_UNDERSCORE
  435.           if (msymbols[mcount].name[0] == '_')
  436.         {
  437.           msymbols[mcount].name++;
  438.         }
  439. #endif
  440. #ifdef SOME_NAMES_HAVE_DOT
  441.           if (msymbols[mcount].name[0] == '.')
  442.         {
  443.           msymbols[mcount].name++;
  444.         }
  445. #endif
  446.         }
  447.       msym_bunch_index = BUNCH_SIZE;
  448.     }
  449.  
  450.       /* Sort the minimal symbols by address.  */
  451.       
  452.       qsort (msymbols, mcount, sizeof (struct minimal_symbol),
  453.          compare_minimal_symbols);
  454.       
  455.       /* Compact out any duplicates, and free up whatever space we are
  456.      no longer using.  */
  457.       
  458.       mcount = compact_minimal_symbols (msymbols, mcount);
  459.  
  460.       obstack_blank (&objfile->symbol_obstack,
  461.     (mcount + 1 - alloc_count) * sizeof (struct minimal_symbol));
  462.       msymbols = (struct minimal_symbol *)
  463.     obstack_finish (&objfile->symbol_obstack);
  464.  
  465.       /* We also terminate the minimal symbol table
  466.      with a "null symbol", which is *not* included in the size of
  467.      the table.  This makes it easier to find the end of the table
  468.      when we are handed a pointer to some symbol in the middle of it.
  469.          Zero out the fields in the "null symbol" allocated at the end
  470.      of the array.  Note that the symbol count does *not* include
  471.      this null symbol, which is why it is indexed by mcount and not
  472.      mcount-1. */
  473.  
  474.       msymbols[mcount].name = NULL;
  475.       msymbols[mcount].address = 0;
  476.       msymbols[mcount].info = NULL;
  477.       msymbols[mcount].type = mst_unknown;
  478.  
  479.       /* Attach the minimal symbol table to the specified objfile.
  480.      The strings themselves are also located in the symbol_obstack
  481.      of this objfile.  */
  482.  
  483.       objfile -> minimal_symbol_count = mcount;
  484.       objfile -> msymbols = msymbols;
  485.     }
  486. }
  487.  
  488.